From cfb026651878dde2b0af21ff8de470527ed5f825 Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Wed, 10 Nov 1999 22:48:46 +0000 Subject: [PATCH] Populated. 1999-11-10 Federico Mena Quintero * doc/tmpl/gdk-pixbuf-loader.sgml: Populated. * doc/gdk-pixbuf.signals: Put in the real names of signal arguments. * src/gdk-pixbuf-loader.c: Improved documentation comments. --- docs/reference/gdk-pixbuf/gdk-pixbuf.signals | 14 ++-- docs/reference/gdk-pixbuf/tmpl/creating.sgml | 3 +- .../gdk-pixbuf/tmpl/file-loading.sgml | 3 +- .../gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml | 63 ++++++++++------ .../reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml | 3 +- .../gdk-pixbuf/tmpl/gnome-canvas-pixbuf.sgml | 74 +++++++++---------- .../gdk-pixbuf/tmpl/refcounting.sgml | 3 +- docs/reference/gdk-pixbuf/tmpl/rendering.sgml | 3 +- gdk-pixbuf/ChangeLog | 9 +++ gdk-pixbuf/gdk-pixbuf-io.c | 2 +- gdk-pixbuf/gdk-pixbuf-loader.c | 34 +++++---- gtk/gdk-pixbuf-loader.c | 34 +++++---- 12 files changed, 136 insertions(+), 109 deletions(-) diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf.signals b/docs/reference/gdk-pixbuf/gdk-pixbuf.signals index d53d607821..82587ac38a 100644 --- a/docs/reference/gdk-pixbuf/gdk-pixbuf.signals +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf.signals @@ -1,22 +1,22 @@ GdkPixbufLoader::area-updated void -GdkPixbufLoader *gdkpixbufloader -gint arg1 -gint arg2 -gint arg3 -gint arg4 +GdkPixbufLoader *loader +gint x +gint y +gint width +gint height GdkPixbufLoader::area-prepared void -GdkPixbufLoader *gdkpixbufloader +GdkPixbufLoader *loader GdkPixbufLoader::closed void -GdkPixbufLoader *gdkpixbufloader +GdkPixbufLoader *loader diff --git a/docs/reference/gdk-pixbuf/tmpl/creating.sgml b/docs/reference/gdk-pixbuf/tmpl/creating.sgml index ae55d3cc89..3c06008c91 100644 --- a/docs/reference/gdk-pixbuf/tmpl/creating.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/creating.sgml @@ -86,8 +86,7 @@ Creating a pixbuf from image data that is already in memory. @data: -@Returns: - #GdkPIxbufLoader provides a way for applications to drive the - process of loading an image. + process of loading an image. Applications can use this + functionality instead of gdk_pixbuf_new_from_file() when they need + to parse image data in small chunks, such as when reading it from + a network connection. - - - + + gdk_pixbuf_new_from_file() + - - - + + Casts a #GtkObject to a #GdkPixbufLoader. + -@obj: +@obj: A GTK+ object. @@ -60,29 +63,40 @@ Application-driven image loading. - - - + + This signal is emitted when a significant area of the image being + loaded has been updated. Normally it means that a complete + scanline has been read in, but it could be a different area as + well. Applications can use this signal to know when to repaint + areas of an image that is being loaded. + -@gdkpixbufloader: the object which received the signal. -@arg1: -@arg2: -@arg3: -@arg4: +@loader: Loader which emitted the signal. +@x: X offset of upper-left corner of the updated area. +@y: Y offset of upper-left corner of the updated area. +@width: Width of updated area. +@height: Height of updated area. - - - + + This signal is emitted when the pixbuf loader has been fed the + initial amount of data that is required to figure out the size and + format of the image that it will create. After this signal is + emitted, applications can call gdk_pixbuf_loader_get_pixbuf() to + fetch the partially-loaded pixbuf. + -@gdkpixbufloader: the object which received the signal. +@loader: Loader which emitted the signal. - - - + + This signal is emitted when gdk_pixbuf_loader_close() is called. + It can be used by different parts of an application to receive + notification when an image loader is closed by the code that + drives it. + -@gdkpixbufloader: the object which received the signal. +@loader: Loader which emitted the signal. + diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml index 87c60ba360..ff31dacb12 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf.sgml @@ -98,8 +98,7 @@ the image data. @pixbuf: -@Returns: - + + Indicates the width the pixbuf will be scaled to. This argument + will only be used if the width_set argument + is %TRUE. If the width_pixels + argument is %FALSE, the width will be taken to be in canvas units, + and thus will be scaled along with the canvas item's affine + transformation. If width_pixels is %TRUE, the width will be taken + to be in pixels, and will visually remain a constant size even if + the item's affine transformation changes. + + Determines whether the - + - Indicates the width the pixbuf will be scaled to. This argument + Indicates the height the pixbuf will be scaled to. This argument will only be used if the width_set argument - is %TRUE. If the width_pixels - argument is %FALSE, the width will be taken to be in canvas units, - and thus will be scaled along with the canvas item's affine - transformation. If width_pixels is %TRUE, the width will be taken - to be in pixels, and will visually remain a constant size even if - the item's affine transformation changes. + linkend="GnomeCanvasPixbuf--height-set">height_set argument + is %TRUE. Works in the same way as the width argument. @@ -210,13 +219,13 @@ Canvas item to display #GdkPixbuf images. argument. The default is %FALSE. - + - Indicates the height the pixbuf will be scaled to. This argument - will only be used if the height_set argument - is %TRUE. Works in the same way as the width argument. + Indicates the horizontal translation offset of the pixbuf item's + image. This argument will only be used if the x_set argument is %TRUE. + This offset may not actually appear horizontal, since it will be + affected by the item's affine transformation. @@ -237,15 +246,21 @@ Canvas item to display #GdkPixbuf images. will change along with the item's affine transformation. - + - Indicates the horizontal translation offset of the pixbuf item's - image. This argument will only be used if the x_set argument is %TRUE. - This offset may not actually appear horizontal, since it will be - affected by the item's affine transformation. + Indicates the vertical translation offset of the pixbuf item's + image. Works in the same way as the x argument. + + + Determines whether the - - - Indicates the vertical translation offset of the pixbuf item's - image. Works in the same way as the x argument. - - - - - diff --git a/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml b/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml index 04ee946324..845d2ceaf6 100644 --- a/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/refcounting.sgml @@ -33,8 +33,7 @@ Functions to perform reference counting on a #GdkPixbuf. -@pixbuf: -